Initial app bootstrapping with cookie cutter. Support for basic routing + Request object #2

mscosti · 2019-10-14T15:10:55Z

I finally might have some time for projects and wanted to get the ball rolling here on this library.

This is 99% Generated from the Cookie Cutter project, following the learn guide for what parameters I should be using. Please let me know if I misunderstood any of the parameters, especially around attribution.

The other 1% is an incredibly pared down version of this example from the ESP32SPI lib, just to kick things off. I picture for some foreseeable time the library code and API will be in flux to allow for quicker development and changing ideas until we land in a spot where we all feel comfortable with the API and structure.

Update:

I've been working on this against my own fork on and off for the past month, so this PR now includes not only the cookie cutter output, but also some new library code that should make handling incoming requests easier.

Features:

Request handlers are passed a higher level Request object to represent the current incoming request, instead of the raw WSGI environ dictionary. See request.py to see extracted properties
Routing with a the @route decorator
- Annotate a method with the url path you want to activate when called, and optionally a list of HTTP request methods the route should match for. If method list empty, default to [GET]
  - ```
   web_app = WSGIApp()
   @web_app.route("led_off") // GET <ip>/led_off
    def led_off.....
  
   @web_app.route("led_on", ["POST"]) // POST <ip>/led_on
   def led_on .....
```
- Routes can include path parameters, using the syntax "<param>", and will parse out the param and pass it to your request handler
  - ```
   @web_app.route("/led_on/<r>/<g>/<b>") // GET <ip>/led_on/255/0/255
    def led_on(request, r, g, b) ....  // r, g, b will be strings "255", "0", and "255"
```

Add pared down version of wsgi application from esp32 example to start

ladyada · 2019-10-14T15:13:33Z

hiya i dont think ya wanna be committng the docs folders, thats generated for you by sphinx (i think?)

mscosti · 2019-10-14T15:16:36Z

Yeah, I just noticed that as well. It looks like I'm missing some files from cookie cutter (like a .gitignore). Looking into that now. I Installed it from pip, do you know if the latest build is available there? cookiecutter -V is saying I have version 1.6.0

ladyada · 2019-10-14T15:18:55Z

i follow
https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/

ladyada · 2019-10-14T15:20:33Z

this is my checklist! https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/checklist

brentru · 2019-10-14T15:27:39Z

@mscosti You may want to test this (and your code in ESP32SPI, too) with the latest version of nina-fw (v1.4.0) on your ESP32.

We've updated the ESP-IDF version which builds nina-fw using ESP-IDF v3.3 (we were previously using ESP-IDF v3.2).

Instructions for upgrading are here: https://learn.adafruit.com/upgrading-esp32-firmware

mscosti · 2019-10-14T16:24:50Z

Looks like I accidentally deleted all the dot files after running cookie cutter, d'oh!

Re ran cookie cutter to get the following files back: .gitignore, .pylintrc, .readthedocs.yml, and .travis.yml
Also removed the generated _build folder from docs.
Look into travis

@brentru Neat! I Will look into upgrading firmware soon, happy to see the guide has been updated to include instructions for external breakout boards :)

mscosti · 2019-10-19T16:46:45Z

@brentru Upgraded firmware on my pyPortal to v1.4 and tested it with no issues on new firmware.

I also added a starter basic simpleTest example.

I think it might be good to go to at least start us off, pending any other comments. @ladyada @brentru

siddacious · 2019-10-22T05:42:22Z

@mscosti I'll take a look at this tomorrow

Add in Route Decorator for registering request handlers

* Fix case where variable part of path would match with 0 characters as value instead of requiring minimum of 1

… request handlers (#4)

siddacious · 2019-11-07T05:14:37Z

@mscosti I copied your fork over to my Metro M4 + Airlift shield, along with a fresh copy of Adafruit_CircuitPython_ESP32SPI and get the following output and error when trying to run the example application. Looking at the code I'm honestly unsure what it's complaining about; as far as I can tell you're just setting an instance attribute?

It's been a while since I worked with this code so it's entirely possible that I'm overlooking something or set up something incorrectly.

mscosti · 2019-11-15T01:44:29Z

thanks for giving it a try! were you in this branch or my master branch? my master branch has some more development done that will be in a future PR. ill plan on looking into reproducing this error this weekend.

@siddacious

* Thanks @siddacious

mscosti · 2019-11-17T17:55:03Z

@siddacious @brentru @ladyada Updated PR to include more work than just cookie cutter output. Now includes some of the features I've been working on on and off over the past month.

@siddacious Thanks for testing! There a few bugs with the Request object that I have since resolved.

kattni · 2020-01-08T18:52:25Z

@siddacious @brentru Can one of you follow up with testing this again with the final updates? It's passing otherwise and may be ready to merge.

siddacious · 2020-01-10T02:37:57Z

@mscosti @kattni I pushed an update to the compare branch to add the rest of the actions changes. I can test tomorrow if need be but from my vantage it's ready to merge

siddacious · 2020-01-10T02:39:56Z

@mscosti when doing the actions patch, I noticed that I was indeed on the master branch when testing which was likely the source of my issues. If you think it's ready to go, go ahead and merge if you have the right permissions. If not, @ me and I'll do it

mscosti · 2020-01-12T15:59:48Z

@siddacious Doesn't look like I have merge permissions to this repo, so if its working for you, I think its probably worth merging to have the groundwork in place to support future additions.

Initial app bootstrapping with cookie cutter

79fe03c

Add pared down version of wsgi application from esp32 example to start

mscosti added 2 commits October 14, 2019 12:13

add . files accidentally removed

1b9879b

remove auto generated docs build

edd6146

mscosti added 6 commits October 14, 2019 12:29

lint the project directory

46b9577

Remove todos

41c8389

appease pylint

63ea6c5

fix sphinx build

182619b

Add simple test

9cda070

remove unused import

3b8faea

mscosti added 5 commits October 26, 2019 16:16

Add in Route Decorator for registering request handlers

3aa1248

Merge pull request #1 from mscosti/routeDecorate

2e38506

Add in Route Decorator for registering request handlers

Add in support for route variables (#2)

249d3c0

Fix case where we execute a handler for a partial match (#3)

8935b8b

* Fix case where variable part of path would match with 0 characters as value instead of requiring minimum of 1

Parse WSGI environ dictionary into a Request object that is passed to…

610365f

… request handlers (#4)

Fix errors with Request object. (#5)

4ae8991

* Thanks @siddacious

mscosti changed the title ~~Initial app bootstrapping with cookie cutter~~ Initial app bootstrapping with cookie cutter. Support for basic routing + Request object Nov 17, 2019

fix linting

872aecb

Updating to complete the actions configuration

5d1b212

siddacious approved these changes Jan 10, 2020

View reviewed changes

siddacious merged commit 5b6e870 into adafruit:master Jan 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Initial app bootstrapping with cookie cutter. Support for basic routing + Request object #2

Initial app bootstrapping with cookie cutter. Support for basic routing + Request object #2

Uh oh!

mscosti commented Oct 14, 2019 •

edited

Loading

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

mscosti commented Oct 14, 2019

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

brentru commented Oct 14, 2019

Uh oh!

mscosti commented Oct 14, 2019 •

edited

Loading

Uh oh!

mscosti commented Oct 19, 2019

Uh oh!

siddacious commented Oct 22, 2019

Uh oh!

siddacious commented Nov 7, 2019

Uh oh!

mscosti commented Nov 15, 2019

Uh oh!

mscosti commented Nov 17, 2019

Uh oh!

kattni commented Jan 8, 2020

Uh oh!

siddacious commented Jan 10, 2020

Uh oh!

siddacious commented Jan 10, 2020 •

edited

Loading

Uh oh!

mscosti commented Jan 12, 2020

Uh oh!

Uh oh!

Initial app bootstrapping with cookie cutter. Support for basic routing + Request object #2

Initial app bootstrapping with cookie cutter. Support for basic routing + Request object #2

Uh oh!

Conversation

mscosti commented Oct 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update:

Features:

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

mscosti commented Oct 14, 2019

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

ladyada commented Oct 14, 2019

Uh oh!

brentru commented Oct 14, 2019

Uh oh!

mscosti commented Oct 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mscosti commented Oct 19, 2019

Uh oh!

siddacious commented Oct 22, 2019

Uh oh!

siddacious commented Nov 7, 2019

Uh oh!

mscosti commented Nov 15, 2019

Uh oh!

mscosti commented Nov 17, 2019

Uh oh!

kattni commented Jan 8, 2020

Uh oh!

siddacious commented Jan 10, 2020

Uh oh!

siddacious commented Jan 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mscosti commented Jan 12, 2020

Uh oh!

Uh oh!

mscosti commented Oct 14, 2019 •

edited

Loading

mscosti commented Oct 14, 2019 •

edited

Loading

siddacious commented Jan 10, 2020 •

edited

Loading